Retrieve list of objects under specified folder

Request

Retrieve a list of objects under a specified folder, including child folders, segments, batch segments, predictive scoring models, funnels, Profile API tokens and Journeys.

Security

TdApikeyAuth

Path

folderIdinteger, (int64)required

Segment Folder ID

Query

depthinteger, (int64)required

Depth of retrieved folders

with_ruleboolean

Set false to ignore the segment rule

Default:true

curl -i -X GET \
  'https://api-cdp.treasuredata.com/entities/by-folder/{folderId}?depth=0&with_rule=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Returns a list of entities under the specified folder. The specified folder is also included.

Bodyapplication/json

dataArray of anyrequired

includedArray of objects(UserJsonApiResource)required

Response

{
  "data": [
    { … }
  ],
  "included": [
    { … }
  ]
}